/*  
 *  Copyright 2006 Paul Jack.
 *
 *  This file is part of the Dex compiler suite. 
 *  
 *  Dex is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by the
 *  Free Software Foundation; either version 2 of the License, or (at your
 *  option) any later version.
 *  
 *  Dex is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
 *  Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
package dex.compiler.model.statement;


import dex.compiler.model.base.Place;
import dex.compiler.model.expression.Expression;


/**
 * A while statement, like <code>while foo { }</code>.
 * @author Paul
 *
 */
public class WhileStatement extends Statement {
	
	
	/**
	 * The expression to test at the beginning of each iteration.
	 */
	private Expression test;


	/**
	 * The statement to execute during every iteration.
	 */
	private Statement body;
	

	/**
	 * Constructs a new while statement.
	 * 
	 * @param place  the place where the while statement originated
	 * @param test   the test condition for the loop
	 * @param body   the body of the loop
	 */
	public WhileStatement(Place place, Expression test, Statement body) {
		super(place);
		if (test == null) {
			throw new IllegalArgumentException("test may not be null");
		}
		if (body == null) {
			throw new IllegalArgumentException("body may not be null");
		}
		this.test = test;
		this.body = body;
	}


	@Override
	public String toString() {
		return "while " + test + " " + body;
	}


	/**
	 * Returns the body of the loop.
	 * 
	 * @return  the body of the loop
	 */
	public Statement getBody() {
		return body;
	}


	/**
	 * Returns the test condition of the loop.
	 *
	 * @return  the test condition of the loop
	 */
	public Expression getTest() {
		return test;
	}


	@Override
	public boolean terminates() {
		return body.terminates();
	}

}
